Update a Shipment Template

SecurityAuthToken
Request
path Parameters
shipmentTemplateId
required
string <uuid>

The ID of the shipment template

Request Body schema: application/json
required
Array of objects or null (Accessorial)
additional_bol_recipients
Array of strings or null
object (BillToOverride)

Collection of bill-to information that will render on Shipment documents

bol_number
string or null
buy_it_now_amount
number or null <float>
Array of objects or null (ShipmentChargeLineItemTemplate)
created_at
string or null <date-time>
object (ShipmentCustomData)

Custom data for Shipment

customer_reference_number
string or null
object (EquipmentType)

Equipment type

id
string or null <uuid>
Array of objects or null (ShipmentLineItem)
max_buy_amount
number or null <float>
object (ShipmentMode)

Standardized code for a shipment mode

notes_for_carrier
string or null
pickup_number
string or null
pro_number
string or null
purchase_order_number
string or null
object (ServiceLevel)

Standardized code for a shipment service level

shipment_name
string or null
Array of objects or null (ShipmentStopTemplate)
tags
Array of strings <uuid>
target_rate_amount
number or null <float>
template_name
required
string
total_declared_value
number or null <float>
object (TotalWeightOverride)
updated_at
string or null <date-time>
customer
string or null <uuid>
vendor
string or null <uuid>
Responses
200

The updated Shipment Template

Response Schema: application/json
Array of objects or null (Accessorial)
additional_bol_recipients
Array of strings or null
object (BillToOverride)

Collection of bill-to information that will render on Shipment documents

bol_number
string or null
buy_it_now_amount
number or null <float>
Array of objects or null (ShipmentChargeLineItemTemplate)
created_at
string or null <date-time>
object (ShipmentCustomData)

Custom data for Shipment

customer_reference_number
string or null
object (EquipmentType)

Equipment type

id
string or null <uuid>
Array of objects or null (ShipmentLineItem)
max_buy_amount
number or null <float>
object (ShipmentMode)

Standardized code for a shipment mode

notes_for_carrier
string or null
pickup_number
string or null
pro_number
string or null
purchase_order_number
string or null
object (ServiceLevel)

Standardized code for a shipment service level

shipment_name
string or null
Array of objects or null (ShipmentStopTemplate)
tags
Array of strings <uuid>
target_rate_amount
number or null <float>
template_name
required
string
total_declared_value
number or null <float>
object (TotalWeightOverride)
updated_at
string or null <date-time>
object (SlimCompany)
object (SlimCompany)
default

Default error response

put/shipments/templates/{shipmentTemplateId}/
Request samples
application/json
{
  • "accessorials": [
    ],
  • "additional_bol_recipients": [
    ],
  • "bill_to_override": {
    },
  • "bol_number": "string",
  • "buy_it_now_amount": 0.1,
  • "charge_line_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_data": {
    },
  • "customer_reference_number": "string",
  • "equipment_type": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "line_items": [
    ],
  • "max_buy_amount": 0.1,
  • "mode": {
    },
  • "notes_for_carrier": "string",
  • "pickup_number": "string",
  • "pro_number": "string",
  • "purchase_order_number": "string",
  • "service_level": {
    },
  • "shipment_name": "string",
  • "stops": [
    ],
  • "tags": [
    ],
  • "target_rate_amount": 0.1,
  • "template_name": "string",
  • "total_declared_value": 0.1,
  • "total_weight_override": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "vendor": "0389db27-b82e-4939-a6bf-21e751cacc66"
}
Response samples
application/json
{
  • "accessorials": [
    ],
  • "additional_bol_recipients": [
    ],
  • "bill_to_override": {
    },
  • "bol_number": "string",
  • "buy_it_now_amount": 0.1,
  • "charge_line_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "custom_data": {
    },
  • "customer_reference_number": "string",
  • "equipment_type": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "line_items": [
    ],
  • "max_buy_amount": 0.1,
  • "mode": {
    },
  • "notes_for_carrier": "string",
  • "pickup_number": "string",
  • "pro_number": "string",
  • "purchase_order_number": "string",
  • "service_level": {
    },
  • "shipment_name": "string",
  • "stops": [
    ],
  • "tags": [
    ],
  • "target_rate_amount": 0.1,
  • "template_name": "string",
  • "total_declared_value": 0.1,
  • "total_weight_override": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "customer": {
    },
  • "vendor": {
    }
}
Copyright © Shipwell 2024. All right reserved.